STraTOS 1997 April & May/STraTOS 1 - 1997 April & May.iso/CD01/DOCS/DIDOC/DID114.TXT

Text File | 1995-12-25 | 89.1 KB | 2,174 lines

Documentation officielle de Diderot V1.14 (version française)
Le   logiciel   d'aide   en   ligne   de  ╜David RENE-LOISEAU
=============================================================

Documentation V1.01 du 24/12/1995 par ╜Jean-Michel COINUS

L'utilisation et la diffusion de cette documentation est libre et gratuite.
Toutefois, toute modification ou exploitation d'une ou toutes parties de ce
texte pour le descriptif de logiciels, matériels ou autres applications est
interdite sans le consentement de l'auteur.

1.0 Introduction

2.0 Principe de l'aide en ligne

3.0 Présentation de l'environnement Diderot

4.0 Installer Diderot
    4.1 Configuration matérielle
    4.2 Diderot en application

5.0 Utiliser Diderot
    5.1 Les boutons
    5.2 L'icône 'Open'
    5.3 L'icône 'i'
    5.4 L'icône '?'
    5.5 L'icône 'Feu tricolore'
        5.5.1 Configuration fenêtre
        5.5.2 Visualisation index
        5.5.3 Général
        5.5.4 Modules
    5.6 L'icône 'Print'
    5.7 Quitter Diderot

6.0 Se déplacer dans Diderot
    6.1 La touche 'Undo'
    6.2 Les raccourcis clavier
    6.3 Les manipulations de la fenêtre

7.0 Créer un fichier d'aide
    7.1 Principe de création
    7.2 Notions sur la syntaxe
    7.3 Retours à la ligne et espaces

8.0 Instructions de base
    8.1 Titre de l'aide
    8.2 Référence
    8.3 Index
    8.4 Exemple simple d'arborescence

9.0 Instructions générales
    9.1 Polices de caractères
        9.1.1 Définir un alias de fonte
        9.1.2 Définir une fonte non-proportionnelle
        9.1.3 Utiliser une fonte non-proportionnelle
        9.1.4 Utiliser une fonte proportionnelle
        9.1.5 Changer la taille d'une fonte
        9.1.6 Changer la couleur d'une fonte
        9.1.7 Créer un fond de page
    9.2 Macros
    9.3 Tabulations
        9.3.1 Tabulation pour l'instruction /begin_src
        9.3.2 Réglettes de texte
    9.4 Format de page
    9.5 Mise en page
        9.5.1 Marges
        9.5.2 Justification
        9.5.3 Largeur de texte
        9.5.4 Multi-colonage

10.0 Instructions spéciales
    10.1 Insertion d'images
        10.1.1 Images simples
        10.1.2 Images interactives
    10.2 Modules sonores
    10.3 Echantillons sonores
    10.4 Zone de page interactive
    10.5 Exécuter un programme sous Diderot
    10.6 Insérer des fichiers d'aide types

11.0 Utiliser le compilateur
    11.1 Paramètres de compilation
    11.2 Erreurs dans la compilation
    11.3 Table des symboles

12.0 Lexique
    12.1 Renommer un fichier
    12.2 Fichier ASCII
    12.3 Editeur de texte
    12.4 Pixel
    12.5 Installer une application
        12.5.1 Description de la boîte de configuration
        12.5.2 Paramètres
        12.5.3 Type de document
        12.5.4 Démarrage
        12.5.5 Appelée par
        12.5.6 Type de fichier
        12.5.7 Répertoire
        12.5.8 Paramètre
        12.5.9 Exemples précis

13.0 Table de correspondance 'caractères/pixels'

14.0 Shareware

15.0 Contacter l'auteur

16.0 Remerciements


1.0 Introduction
================

Depuis l'avènement WINDOWS, une véritable mutation a eu lieu au niveau des
applications développées dans le monde PC, et force est de constater que
ces dernières ont non seulement comblé leur retard par rapport au monde
Macintosh╛ et Atari╛ en matière de mise en oeuvre, d'utilisation et
d'environnement, mais qu'en plus, elles tendent à s'imposer à nous tous,
tant elles ont su mettre en valeur leur côté didactique. L'aide en ligne,
présente dans toute application PC, en est une bonne preuve. Point n'est
besoin de rechercher dans le logiciel ou dans le manuel où se trouve telle
ou telle fonction ou sa signification. L'aide en ligne est présente pour
vous renseigner et vous satisfaire.

Diderot a été conçu pour tous, développeurs ou simples utilisateurs. Il
vient pallier un cruel défaut constaté dans le monde Atari╛ et sait mettre
en exergue le coté intuitif, convivial, pratique, performant, didactique de
votre application préférée.

En dehors de son rôle principal d'aide en ligne, Diderot peut-être utilisé
comme un magazine, un jeu de rôle et pour bien d'autres applications. Il
peut être alors considéré comme un CD-Rom interactif ! Diderot sait gérer
des textes, des images et même des musiques !

2.0 Principe de l'aide en ligne
===============================

Comme décrit dans l'introduction, l'aide en ligne permet de documenter
rapidement une fonction d'un logiciel sans pour autant fouiller dans un
manuel. Pour cela, un logiciel d'aide en ligne doit être à portée de main,
et en l'occurrence en accessoire de bureau sur Atari╛, pour qu'il prenne
toute sa puissance. Il ne faut cependant pas oublier les systèmes
multi-tâches qui permettent l'utilisation de plusieurs programmes en même
temps.

Lors de l'utilisation d'une application, vous désirez effectuer une
fonction que vous ne connaissez pas. Vous ouvrez alors l'accessoire d'aide
en ligne et celui-ci vous propose un choix de rubriques appelées : index.
Ces index peuvent être sous forme d'images ou de mots mis en valeur
(soulignement, couleur différente, ...). A cet instant, vous devrez cliquer
sur le mot ou l'image relatif à l'information que vous souhaitez
recueillir. L'aide en ligne vous amènera alors immédiatement à l'endroit
désiré. Suivant la précision de l'arborescence, vous pourrez à nouveau
cliquer sur d'autres index qui vous apporteront d'autres détails sur votre
fonction.

Lorsque l'accessoire d'aide en ligne est géré directement par
l'application, vous pourrez cliquer directement sur un bouton d'aide à
l'intérieur même de cette application. A cet instant, l'accessoire d'aide
s'ouvrira automatiquement à la page de la fonction demandée. Ce système
s'appelle l'aide contextuelle.

3.0 Présentation de l'environnement Diderot
===========================================

Diderot a 2 facettes. La première est celle de l'accessoire ou du programme
(puisqu'il peut être renommé). Diderot vous permettra de charger des
fichiers d'aide spécifiques dont l'extension est *.AID. Ces aides ne sont
pas de simples fichiers ASCII mais des fichiers dits compilés. Pour créer
ces fichiers, il existe donc une deuxième facette qui s'appelle le
compilateur. Autrement dit, la création d'un fichier Diderot se fait
initialement à l'aide d'un éditeur de texte. Une fois votre aide rédigée,
vous organiserez votre arborescence et sa présentation avec une syntaxe
spécifique. L'aide terminée, vous utiliserez alors un logiciel annexe
appelé compilateur qui créera le fichier *.AID.

Impression :

A noter que Diderot permet d'imprimer ses fichiers d'aide seulement si
SpeedoGdos┐ ou NVDI est actif, soit en page à page ou en totalité. Vous
pourrez donc associer un manuel traditionnel à l'utilisation de votre
application.

Polices de caractères vectorielles :

Pour compléter l'environnement de Diderot, il vous sera fortement
recommandé de posséder un logiciel gestionnaire de polices de caractères
sous GDOS comme SpeedoGdos┐ ou NVDI. Effectivement, Diderot sait gérer les
polices de caractères vectorielles tant dans sa présentation qu'à
l'impression. Cependant, ces logiciels ne sont pas obligatoires pour le
fonctionnement de Diderot.

Utilisation sans SpeedoGdos┐ ou NVDI :

Toutefois, lorsqu'un fichier d'aide a été conçu pour utiliser des polices
vectorielles, celles-ci doivent être présentes dans le répertoire défini
par SpeedoGdos┐ ou NVDI. Lorsqu'une partie ou toutes les fontes
vectorielles ne peuvent être disponibles, Diderot se chargera d'afficher
les textes avec la fonte système. Il se peut que l'affichage ne soit plus
cohérent avec la présentation initiale. Aussi, certains développeurs
mettent à disposition 2 versions du fichier d'aide. En conséquence, quand
vous n'utilisez pas GDOS, vous êtes sûr d'avoir une présentation adaptée.

4.0 Installer Diderot
=====================

Diderot sera installé dans le répertoire de démarrage de votre système s'il
est en accessoire : disque C: si vous avez un disque dur, disquette A: si
vous n'en avez pas. N'oubliez pas de copier également le fichier ressource
qui porte l'extension *.RSC si il en existe un. Effectivement, depuis la
version 1.14 de Diderot, le fichier ressource est intégré dans le
programme. Sous forme de programme, il peut être installé sur n'importe
quelle unité et dans n'importe quel répertoire. S'il existe un fichier
portant l'extension *.CNF, vous pourrez aussi le copier mais ce n'est pas
un impératif. Ce fichier comporte différents paramètres de configuration.
S'il n'existe pas, il sera automatiquement généré par Diderot.

4.1 Configuration matérielle
----------------------------

Diderot fonctionne sur toutes les machines Atari╛ du ST au Falcon, en
monochrome jusqu'en haute résolution couleur. Par contre Diderot ne
fonctionne pas en basse et moyenne résolution. Si vous n'utilisez pas
SpeedoGdos┐ ou NVDI, un disque dur n'est pas nécessaire et une mémoire de
512Ko peut être suffisante si vos fichiers d'aide ne sont pas trop
importants. Du moment où vous utilisez SpeedoGdos┐ ou NVDI, il paraît
utopique de ne pas posséder un disque dur et une mémoire inférieure à 2Mo
pour travailler correctement !

4.2 Diderot en application
--------------------------

Diderot peut être installé en tant qu'application à partir du bureau au
travers de messages internes au GEM. Le principe de l'application est
simple, puisqu'une fois installée, il suffira de double-cliquer sur un
fichier *.AID et l'accessoire de Diderot sera ouvert automatiquement. De
plus, le fichier *.AID sélectionné sera chargé lui aussi à l'intérieur de
Diderot.

Pour cela, il faut utiliser le programme annexe nommé TUBE_AID.GTP fourni
avec Diderot. L'installation de l'application se fait donc à partir de ce
programme avec pour type de document 'AID'.

La première façon d'utilisation décrite précédemment fonctionne très bien
en multi-tâches sous Mint. Par contre, sous TOS normal, le GEM demande à
Diderot de se refermer lorsque qu'il quitte TUBE_AID.GTP.

Il existe aussi une deuxième manière d'utiliser ce type d'application. Dans
ce cas, il suffit simplement de déplacer l'icône d'un fichier *.AID sur le
programme TUBE_AID.GTP et le processus sera identique.

Protocole 'Drag & Drop' :

Diderot gère le protocole 'Drag & Drop' sous MultiTos (système
multi-tâches). Ce protocole est semblable à ce qui a été décrit
précédemment. Lorsque Diderot a l'une de ses fenêtres ouverte, y compris la
fenêtre d'informations, vous pourrez déplacer l'icône d'un fichier *.AID
directement sur l'une de celles-ci.

Si vous n'êtes pas très informé sur les installations d'applications,
consultez le lexique en fin de cette documentation.

5.0 Utiliser Diderot
====================

Diderot respecte le GEM et se trouve en fenêtre qui peut être
redimensionnée comme n'importe quelle autre. Tout d'abord, vous pouvez
remarquer l'existence d'une boîte à outils constituée de 3 boutons et de 5
icônes. Les boutons servent seulement à vous déplacer dans l'arborescence
de l'aide. Bien que cela puisse paraître insuffisant, bien d'autres
raccourcis clavier sont implémentés et vous permettront d'autres fonctions
associées. Les icônes permettent d'ouvrir une aide, de voir la liste de
tous les index contenus dans une aide, de configurer Diderot, d'imprimer
votre aide ou d'apporter des informations.

La majorité des boutons sont accessibles par raccourcis clavier. Ces
raccourcis sont reconnaissables par l'une des lettres soulignée et qui
apparaît en rouge lorsque vous êtes en résolution couleur. Vous devrez donc
appuyer simultanément sur la touche [Alternate] et la lettre
correspondante.

5.1 Les boutons
---------------

|< [Clr Home]

Ce bouton vous permettra toujours de revenir au sommaire général de l'aide
où que vous soyez.

< [Control]+[<]

Ce bouton permet de revenir à la page précédente. Il est bien entendu
inactif lorsque vous vous trouvez au sommaire général (qui en principe est
la première référence).

> [Control]+[>]

Ce bouton permet de passer à la page suivante. Il est bien entendu inactif
lorsque vous vous trouvez à la fin de l'aide.

5.2 L'icône 'Open'
------------------

Ouvrir une aide [Control]+[O]

L'action sur cette icône permet d'ouvrir le sélecteur d'objets et en
conséquence de charger un fichier d'aide (extension *.AID). Le chemin du
répertoire est automatiquement sauvegardé dans le fichier *.CNF. A noter
que dans la boîte de configuration de Diderot, vous pourrez définir le
chargement d'une aide par défaut.

5.3 L'icône 'i'
---------------

Information [Control]+[I]

Comme tout logiciel, vous trouverez derrière cette icône différentes
informations sur l'auteur et son utilisation légale.

Tout d'abord, vous serez confronté au beau portrait de notre cher Diderot
pour ceux qui ne le connaissent pas. Le bouton [Info] vous présente une
boîte avec les coordonnées de l'auteur, des informations légales à
l'utilisation du logiciel. Le bouton [Merci] affiche les noms des personnes
qui ont étroitement collaboré à la création et à l'évolution du logiciel.

Le bouton [Enregistrement] vous concerne lorsque vous vous êtes enregistré
auprès de l'auteur. Après réception de votre clé, vous devrez saisir vos
nom et adresse ainsi que le numéro de série et votre clé personnelle. Après
avoir validé les informations, Diderot vous demandera de le localiser afin
qu'il puisse y enregistrer ces données. Dès lors, vous pourrez utiliser
sans contraintes le logiciel, le portrait de Diderot ne sera plus affiché à
chaque lancement et vous aurez accès à l'impression.

5.4 L'icône '?'
---------------

Depuis la version 1.14 de Diderot, l'icône '?' est accessible. Lorsque l'on
clique dessus apparaît un menu popup qui affiche la liste de toutes les
références contenues dans l'aide. En cliquant sur l'une des références,
vous pouvez directement accéder à la page correspondante. Les 2 flèches en
haut en bas du menu popup permettent de faire défiler la liste. Un clic à
l'extérieur du menu permet de quitter la liste.

5.5 L'icône 'feu tricolore'
---------------------------

Cette icône vous permet d'accéder au panneau de configuration. Son
raccourci clavier est [Control]+[C]. Vous pourrez y configurer tout ce que
vous verrez dans la fenêtre d'aide.

5.5.1. Configuration fenêtre
----------------------------

* Redimensionnement automatique

Lorsqu'une page d'aide n'occupe pas toute la surface de la fenêtre, en
activant cette fonction, la fenêtre sera redimensionnée à la taille
qu'occupe la page. Si vous souhaitez que votre fenêtre garde la même taille
pour toutes les pages, vous devez désactiver cette fonction. L'on utilisera
plutôt cette fonction avec des écrans supérieurs à 14 pouces. Avantage :
l'affichage est optimisé à l'écran, et donc la fenêtre Diderot ne prendra
que la place dont elle a besoin pour la référence. Par contre son
inconvénient est surtout mis en évidence lorsque vous utilisez un logiciel
qui prend beaucoup de temps lors de ses réaffichages et avec des
redimensionnements intensifs, le programme principal recevra une multitude
de message de réaffichage qui peuvent devenir désagréables à la longue.

* Zoom automatique en largeur

Permet de redimensionner la page proportionnellement à la largeur de la
fenêtre, c'est-à-dire que si vous réduisez la fenêtre, la largeur de votre
page ainsi que les polices de caractères seront automatiquement réduites à
la taille désirée. Ce système évite le défilement du texte par l'ascenseur
horizontal. Aussi, une réduction exagérée peut entraîner une lisibilité
insuffisante. Parfois l'affichage peut se bloquer car SpeedoGdos┐ ne peut
plus calculer la taille des caractères.A noter que ceci est complètement
aléatoire.

* Afficher fond en monochrome

Lorsque vous êtes en résolution monochrome et que certaines pages d'aide
comportent des fonds colorés, vous pouvez décider d'afficher ceux-ci en
monochrome en activant cette fonction. Si par exemple un fond a été défini
initialement en rouge 100%, en monochrome, le fond sera noir, ce qui peut
poser quelques problèmes !

* Zoom 100%

Si toutefois un fichier d'aide comporte des textes ou images d'une taille
trop importante, il peut paraître fastidieux de se déplacer sans arrêt dans
la fenêtre. Vous pouvez donc réduire, mais même augmenter les proportions
de l'affichage en valeur de pourcentage.

5.5.2 Visualisation index
-------------------------

Ce bouton ouvre une boîte qui va vous permettre de définir l'aspect des
index. Ce sont les mots qui devront être repérables afin que vous puissiez
y cliquer dessus.

* Contour index

Vous pouvez définir un cadre, la moitié d'un cadre, le soulignement d'un
index ou même rien. Dessous se trouve 3 menus popup. Le premier permet de
choisir le motif de fond (trame). Ce motif ne peut apparaître que si vous
avez choisi un cadre ou un demi-cadre. Ensuite, sélectionnez la couleur de
ce fond (couleur trame). La couleur de fond n'est active que si vous avez
choisi un motif noir ou grisé. Il ne vous reste plus qu'à spécifier la
couleur du cadre si vous en avez sélectionné un.

* Couleur texte

Vous pouvez simplement définir ici la couleur du texte. Dans le cadre
supérieur est affiché l'aspect final de l'index tel qu'il le sera dans
l'aide.

En monochrome, seuls sont bien sûr disponibles le blanc et le noir ainsi
que les motifs de fond. Bien qu'il soit possible de faire n'importe quoi
avec les couleurs, attention à ne pas définir un index sans cadre ou
soulignement et un texte noir sur fond blanc, sans quoi, vous ne pourrez
plus repérer vos index !

5.5.3 Général
-------------

* Pas chercher les pilotes à l'init

Lorsque vous utilisez SpeedoGdos┐ avec Diderot, l'accessoire ou le
programme peut charger les pilotes d'impression lorsque vous l'exécutez. Si
vous souhaitez accélérer le lancement de Diderot, activez cette fonction.
Cette opération de recherche des pilotes d'impression à pour but de remplir
le menu popup dans la boîte de configuration de l'impression avec le nom
des imprimantes disponibles dans votre système. Lorsque vous voudrez
imprimer une page, vous n'aurez plus qu'à choisir l'imprimante désirée.

* Aide par défaut

Vous pouvez définir ici quelle est l'aide qui sera chargée par défaut
lorsque vous lancerez Diderot. Double-cliquez sur le champ à droite du
bouton. Le sélecteur d'objets ouvert vous permettra de choisir votre
fichier d'aide. Vous pouvez aussi entrer le nom du répertoire au clavier en
cliquant simplement sur le champ.

5.5.4 Modules
-------------

Diderot a la faculté de pouvoir collaborer avec l'accessoire U-TRACK qui
permet d'écouter des modules sonores.

Si un fichier aide comporte l'instruction relative à l'exécution de modules
sonores, vous pouvez spécifier le répertoire où se trouvent ces modules
(extension *.MOD). Pour cela, double-cliquez sur le champ 'Chemin des
modules'. Le sélecteur d'objets ouvert vous permettra de choisir le ou les
répertoires où se trouvent vos modules. Vous pouvez aussi entrer les
répertoires au clavier en cliquant simplement sur le champ. Ensuite,
activez le bouton 'Jouer les modules'.

Comme vous l'avez constaté précédemment, l'on peut définir plusieurs
répertoires différents. Pour cela, chaque répertoire devra être séparé par
un point-virgule ';'. Exemple : d:\modules\;e:\diderot\

L'ajout de modules sonores dans une aide est décrit au chapitre 10.2.

5.6 L'icône 'Print'
-------------------

Cette icône est aussi accessible par [Control]+[P]. 'Print' veut dire
imprimer. Vous allez pouvoir imprimer certaines pages de l'aide ou son
intégralité. A noter que cette icône n'apparaît pas si votre version n'est
pas enregistrée auprès de l'auteur.

* Imprimer quoi ?

Vous pouvez définir si vous désirez imprimer la page de l'aide actuellement
affichée ou l'ensemble des pages.

Quelques paramètres vous permettent de choisir le nombre d'exemplaires, le
taux de reproduction grâce à la souplesse des polices de caractères
vectorielles.

Avant de commencer l'impression, vous devrez spécifier quel est le pilote
GDOS adapté à votre imprimante. Si vous utilisez SpeedoGdos┐ ou NVDI, il
est inutile de vous rappeler que ces pilotes d'imprimantes sont définis
dans le fichier ASSIGN.SYS.

Si le menu popup 'Imprimante' indique 'Indisponible', cliquez avant sur
'Rechercher pilotes d'imprimante'. Diderot ira chercher ce qui se trouve
dans le fichier ASSIGN.SYS. Ensuite, choisissez l'imprimante désirée si
vous en utilisez plusieurs.

Dans le cas où SpeedoGdos┐ n'est pas présent, la recherche des drivers
n'est pas effectuée et l'impression ne sera pas possible.

Pour terminer, pensez à désactiver l'option 'Imprimer les fonds' si vous ne
désirez pas voir sur vos feuilles les éventuelles fonds des pages d'aide.

5.7 Quitter Diderot
-------------------

Il n'y a pas d'icône spécifique pour quitter Diderot. Vous pouvez donc
taper [Control]+[Q] ou cliquer sur le bouton de fermeture de la fenêtre.

6.0 Se déplacer dans Diderot
============================

Une fois que vous avez chargé un fichier d'aide, vous êtes immédiatement
prêt à le consulter. Les commandes de déplacement élémentaires sont celles
décrites précédemment : les boutons |<, < et >. Vous pouvez donc vous
déplacer comme si vous lisiez un livre.

Aussi, et tel est le but principal de l'aide en ligne, vous serez amené à
consulter un chapitre particulier. Lors du chargement d'une aide, celle-ci
se trouve systématiquement au sommaire principal. Dans le cas de
documentations traditionnelles, vous y retrouverez une table des matières
où apparaîtront les différents chapitres. Certains mots ou phrases seront
mis en valeur en étant soulignés, encadrés, en couleur, ... Si vous
souhaitez vous reporter directement au chapitre concerné, cliquez sur
l'index choisi. Vous serez amené directement à celui-ci.

Certains de ces chapitres peuvent eux aussi comporter d'autres index
accédant à d'autres informations. A cet instant, vous vous déplacez dans
l'aide non pas comme un livre mais en fonction d'une recherche précise.

Images :

Les index ne sont pas forcément des mots ou phrases, mais aussi des images.
Parfois, l'on vous demandera de cliquer dans une image ou même une partie
précise de celle-ci. Dans tous les cas, vous serez amené à l'endroit
relatif à cette image.

Sons et musiques :

Contrairement aux autres index, certains peuvent simplement générer un son
ou une musique et donc ne permettent pas de se déplacer dans le fichier
d'aide. Cette fonctionnalité peut être utilisée dans le cas d'un fichier
organisé en audiothèque où vous souhaitez écouter un extrait d'une chanson.

6.1 La touche [Undo]
--------------------

Lorsque vous commencez à vous perdre dans les dédales d'une arborescence,
vous êtes toujours à temps de revenir à la première page de l'aide,
généralement le sommaire général.

Vous avez cependant la possibilité de retourner à la précédente page
consultée en tapant sur la touche [Undo] ou en cliquant le bouton droit de
la souris. De même, vous pourrez faire l'inverse, en revenant là où vous
étiez auparavant avec [Shift]+[Undo].

Exemple d'une arborescence simple :

1 Sommaire
2 Configuration
3 Imprimer
4 Ouvrir
5 Informations

Après le chargement d'une aide, vous vous trouvez en (1). A partir de ce
sommaire, vous choisissez d'aller en (3), puis en (5). Vous êtes donc
maintenant dans 'Informations'.

    - Si vous tapez [Clr Home], vous revenez en (1).
    - Si vous tapez [Undo], vous revenez en (3).

Si vous avez choisi de revenir en (1), [Shift]+[Undo] vous ramènera en (5).
Il en est de même si vous vous aviez choisi de revenir en (3).

S'il vous est difficile de comprendre le fonctionnement des arborescences,
essayez par vous-même. C'est le meilleur moyen d'apprendre !

6.2 Les raccourcis clavier
--------------------------

[Control]+[O]           Charger un fichier d'aide
[Control]+[I]           Informations sur Diderot
[Control]+[C]           Configuration
[Control]+[P]           Impression
[Control]+[Q]           Quitter Diderot
[Control]+[<]           Page d'aide précédente
[Control]+[>]           Page d'aide suivante
[Control]+[^]           Début de la page
[Control]+[v]           Fin de la page
[Clr Home]              Première page d'aide
[Control]+[Clr Home]    Dernière page d'aide
[Undo]                  Retourne à la précédente page d'aide consultée
[Shift]+[Undo]          Revient à la dernière page d'aide consultée

6.3 Les manipulations de la fenêtre
-----------------------------------

[>]             Fait défiler la page d'une colonne vers la droite
[<]             Fait défiler la page d'une colonne vers la gauche
[^]             Fait défiler la page d'une ligne vers le haut
[v]             Fait défiler la page d'une ligne vers le bas
[Shift]+[>]     Fait défiler la page de plusieurs colonnes vers la droite
[Shift]+[<]     Fait défiler la page de plusieurs colonnes vers la gauche
[Shift]+[^]     Fait défiler la page de plusieurs lignes vers le haut
[Shift]+[v]     Fait défiler la page de plusieurs lignes vers le bas

7.0 Créer un fichier d'aide
===========================

Pour créer un fichier d'aide, vous devez tout d'abord disposer du programme
annexe appelé compilateur. Ce programme, qui n'a pas d'interface GEM est
reconnaissable par son extension GTP (application GEM avec paramètres). Là
aussi, suivant le type de machine que vous utilisez, vous aurez le choix
entre les versions DIDCOM00.GTP (68000) pour les ST(E) et DIDCOM30.GTP
(68030) pour les TT et Falcon. A noter que ces programmes ne peuvent être
disponibles que si vous êtes utilisateur enregistré auprès de l'auteur.

Le deuxième outil principal est l'éditeur de texte. C'est lui qui va vous
permettre de saisir votre texte et toute la syntaxe nécessaire à la
présentation de votre aide. A noter qu'aucun éditeur n'est fourni avec
Diderot.

Enfin, il reste des outils non impératifs comme un utilitaire de dessin
reconnaissant le format d'image GEM-IMG, un accessoire ou programme de
capture d'écran monochrome pour créer vos images. Et encore, un utilitaire
d'enregistrement sonore ainsi qu'un éditeur pour créer des sons ou des
musiques. Par exemple, le logiciel SAM fera amplement l'affaire.

7.1 Principe de création
------------------------

Dès lors que vous aurez construit un fichier d'aide avec l'éditeur de
texte, celui-ci devra porter l'extension *.HLP. Ce fichier n'étant pas
exploitable directement par Diderot, vous devrez le compiler avec le
programme DIDCOMxx.GTP.

Une fois le fichier compilé, un nouveau fichier portant l'extension *.AID
sera généré. Celui pourra donc être directement chargé dans Diderot.

Pourquoi un compilateur :

L'on utilise un compilateur essentiellement pour interpréter le fichier
*.HLP. Ce compilateur va donc vérifier si la syntaxe est correcte et
détecter les éventuelles erreurs qui auraient été commises. Vous pourrez
éventuellement demander à ce que le compilateur vous fournisse un fichier
récapitulatif de ces erreurs. De plus, lorsque vous intégrez des sons ou
des images, ces éléments sont des fichiers externes à l'aide. Le
compilateur va donc rechercher tous ces fichiers et les assembler en un
seul qui sera votre fichier d'aide, ce qui est plus facile à l'utilisation.

7.2 Notions sur la syntaxe
--------------------------

La syntaxe est en fait un langage propre à Diderot. Ce sont des
instructions qui vous permettront de définir ce que vous voulez faire avec
votre texte, vos images et vos sons. En clair, vous allez expliquer à
Diderot que si l'on clique à tel endroit, il devra aller à tel endroit ou
jouer tel son.

Ces instructions sont reconnaissables puisqu'elles sont précédées d'un '/',
barre oblique ou plus communément appelé 'slash'. Elles pourront être en
majuscules ou en minuscules. Certains paramètres pourront être séparés par
une virgule, un point-virgule et même des parenthèses. Il faudra donc
respecter avec attention cette syntaxe. Sans quoi, le compilateur vous
renverra les erreurs trouvées.

Si vous voulez utiliser le slash '/', l'anti-slash '\' ou un '{' en tant
que caractère normal, chacun de ces caractères devra être précédé d'un
anti-slash '\'.

Exemples :

\\ affiche un \
\/ affiche un /
\{ affiche un {

A noter aussi que certaines instructions sont composées de plusieurs mots.
Vous remarquerez que ceux-ci sont séparés par un tiret de soulignage '_'.
Attention à ne pas oublier ces tirets, sans quoi, l'instruction ne sera pas
reconnue.

Toute instruction placée dans un texte devra être précédée d'un espace
(sauf si elle est en début d'une ligne) et suivie d'un autre espace si
d'autres mots suivent celle-ci. Voici quelques exemples avec l'instruction
fantaisiste /toto et /toto(paramètres) :

/toto                           < pas d'espaces nécessaires
Votre texte

Votre /toto texte               < espaces obligatoires

/toto Votre texte               < espace nécessaire après /toto

/toto(paramètres)               < pas d'espaces nécessaires
Votre texte

Votre /toto(paramètres) texte   < espaces obligatoires

/toto(paramètres) Votre texte   < espace nécessaire après /toto(paramètres)

7.3 Retours à ligne et espaces
------------------------------

Lors de la saisie d'un texte, il faudra vérifier continuellement
l'existence d'espaces et de retour chariot à la fin des lignes et des
paragraphes. En règle générale, chaque fois que vous tapez [Return] à la
fin d'une ligne, un éditeur de texte génère 2 caractères transparents ou
matérialisés par des symboles. Il s'agit d'un retour chariot (CR) et d'un
saut de ligne (LF). En fait, cela veut dire que le curseur revient au début
de la ligne puis se déplace à la ligne suivante.

Toutefois, certains éditeurs ne génèrent pas de CR ou de LF. Si c'est le
cas, vous devrez l'ajouter en fin de ligne par les instructions suivantes :
/CR /NL /LF ou /CRLF.

En ce qui concerne les espaces en fin de ligne, ils définissent tout
simplement la fin d'un paragraphe ou d'une ligne si elle doit être seule.

Exemples de textes avec retour chariot spécifié :

aaaaa bbbbb ccccc /CR   < sans espace de fin
ddddd eeeee fffff /CR   < fin de paragraphe (avec espace)
                        < ligne vide (espace au début de la ligne)
ggggg hhhhh iiiii /CR   < fin de paragraphe (avec espace)

Aspect final :

aaaaa bbbbb ccccc ddddd eeeee fffff

ggggg hhhhh iiiii

Aspect final avec une justification de texte de faible longueur :

aaaaa bbbbb
ccccc ddddd
eeeee fffff

ggggg hhhhh
iiiii

Si votre éditeur de texte génère les retour chariot, il est donc inutile de
faire paraître l'instruction /CR.

Rappelez-vous que vous pouvez taper votre texte comme vous le désirez dans
l'éditeur de texte. Une ligne de 132 caractères ne sera pas forcement
représentée telle quelle est tapée. Respectez seulement les espaces en fin
de ligne pour définir la fin d'un paragraphe ou en début de ligne quand
vous laissez une ligne vierge. La présentation finale sera définie par des
instructions spécifiques de justification : longueur de texte, marges,
alignement à gauche, ...

Conseil :

Chaque fin de page d'une aide devra avoir une ligne vierge si la marge de
bas de page n'est pas utilisée. Cette ligne supplémentaire permet lors de
la consultation de l'aide finale que le texte ne soit pas coupé par le bord
de la fenêtre.

8.0 Instructions de base
========================

Tout fichier d'aide devra commencer obligatoirement par une ligne : %%
Diderot Language 1.0 %%. Sans quoi, le fichier ne serait pas reconnu par le
compilateur.

Commentaires :

A n'importe quel endroit de votre fichier d'aide, vous pourrez apporter des
commentaires ou informations complémentaires qui ne seront pas reconnues
par le compilateur et en conséquence qui n'apparaîtront pas dans l'aide
finale. Pour cela, ces chaînes de caractères qui peuvent être sur plusieurs
lignes devront commencer par 2 %% et se terminer par 2 %%.

Conseil :

Vous pourrez aussi inhiber une partie non utilisée de l'aide temporairement
grâce à ce principe.

8.1 Titre de l'aide
-------------------

/title(titre de l'aide)

Cette instruction permet à Diderot d'afficher le titre de l'aide dans la
barre de titre de la fenêtre principale. La chaîne de caractères entre
parenthèses ne doit pas dépasser 40 caractères.

Exemple : /title(Aide pour Diderot)

8.2 Référence
-------------

Chaque page d'une aide doit pouvoir être identifiée. Pour cela, l'on doit
donner une référence à chacune d'entre-elles. Ce peut être un nom comme
'Sommaire' ou 'Page 1' mais aussi un nombre comme pour repérer un chapitre.
En résumé, chaque fois que l'on rencontre une référence, l'on est au début
d'une page. La fin de cette page est définie par la référence suivante.

/ref(nom de la page)

Exemple : /ref(sommaire) ou /ref(1)

Note à l'attention des développeurs de logiciels:

L'instruction /ref peut être étendue. Cela concerne les développeurs qui
souhaitent intégrer Diderot comme système d'aide contextuel dans leur
programme.

Exemple : /ref(couleur,color) ou /ref(couleur)

Ici, 'couleur' désigne la référence qui sera appelée par l'instruction
/index et 'color' désigne la variable qui va être utilisée dans le
programme du développeur lors de l'appel de Diderot. D'ailleurs, pour
éviter les confusions dans les noms de variables, Diderot rajoute
automatiquement un tiret de soulignage '_' tel que 'diderot_' devant le nom
de la variable qui aura été donné.

Dans l'exemple ci-dessus, le résultat dans le fichier *.H sera :

#define diderot_color 5 pour le langage C
let diderot_color = 5 pour le Basic

Pour générer les fichiers *.H et *.LST, consultez le chapitre 11.0.

8.3 Index
---------

/index(texte affiché,nom de la référence)

L'index représente un mot ou une phrase mis en valeur dans un texte. L'on
va donc spécifier quel est le texte qui sera souligné ou encadré et quelle
est la référence qui lui est associée.

Exemple : /index(Utiliser Diderot,5.0)

Dans la page du sommaire, le texte 'Utiliser Diderot' est mis en valeur.
Vous pouvez donc cliquer dessus et vous serez amené au chapitre
correspondant dont la référence est /ref(5.0).

Concernant les parenthèses '(' et ')' qui sont déjà utilisées pour définir
les paramètres de l'instruction, vous pouvez inclure d'autres parenthèses à
l'intérieur même. Si dans exemple, 'Utiliser Diderot' était en en
parenthèses '(Utiliser Diderot)', cela donnerai :

/index((Utiliser Diderot),5.0)

Note :

L'instruction ne sera pas reconnue si elle est coupée dans le fichier. Il
en est de même si un point se trouve à la fin de celle-ci.

/index(Utiliser
Diderot,5.0)

/index(Utiliser Diderot,5.0).

Lorsque que l'index se trouve en fin d'une phrase et qu'un point est donc
nécessaire, placez un espace avant celui-ci.

/index(Utiliser Diderot,5.0) .

8.4 Exemple simple d'arborescence
---------------------------------

/ref(sommaire)

1.0 /index(Introduction,10)
2.0 /index(Principes,20) d'utilisation
2.1 /index(Exemples,21) concrets

/ref(10)
Introduction : il était une fois...

/ref(20)
L'un des principes est de retourner au /index(début de l'aide,Sommaire).

/ref(21)
Exemple concret : consultez les /index(principes,20) d'utilisation ou
revenez au /index(sommaire,Sommaire).

Aspect final (les textes entre crochets sont les index) :

1.0 [Introduction]
2.0 [Principes] d'utilisation
2.1 [Exemples] concrets
-----------------------------
Introduction : il était une fois...
-----------------------------------
L'un des principes est de retourner au [début de l'aide].
---------------------------------------------------------
Exemple concret : consultez les [principes] d'utilisation ou revenez au
[sommaire].

9.0 Instructions générales
==========================

Vous trouverez dans les instructions générales toutes les syntaxes
relatives à la présentation de l'aide : choix des polices de caractères,
justification du texte, marges, ...

9.1 Polices de caractères
-------------------------

Note : dans les différentes descriptions, l'on utilisera indifféremment le
terme de police de caractères ou de fonte.

Diderot propose différentes instructions qui permettent d'utiliser des
polices de caractères vectorielles ou non. Si vous créez une aide
uniquement avec la fonte système, certaines instructions ne vous seront
d'aucune utilité. Aussi, la souplesse est moindre en ce qui concerne la
taille des caractères. A noter qu'une taille supérieure à 20 points en
fonte système donne un aspect peu embellissant !

Une police de caractères est dite non proportionnelle lorsque chaque
caractère a une largeur identique. Dans ce cas, comme la fonte système, un
'i' prendra la même place qu'un 'w'. A l'inverse, une fonte proportionnelle
optimise la place en fonction des caractères. Ce qui veut dire que 'wiwi'
en mode non-proportionnel sera plus long qu'un 'wiwi' en mode
proportionnel.

Conseil :

Bien qu'il soit possible de faire n'importe quoi avec les polices
vectorielles, évitez d'utiliser des tailles trop petites et des styles un
peu trop originaux. Souvenez-vous qu'une aide en ligne doit être claire et
surtout lisible afin que l'utilisateur puisse facilement y trouver ce qu'il
cherche.

9.1.1 Définir un alias de fonte
-------------------------------

Un alias est en fait dans ce cas un nom de remplacement. Les noms de
polices de caractères utilisés par exemple par SpeedoGdos┐ sont parfois
long. C'est pourquoi l'on va pouvoir appeler une fonte par 'Gras' ou par
tout autre nom lorsqu'on voudra utiliser la police 'Swiss 721 Bold'. Pour
connaître le nom exact d'un police SpeedoGdos┐, vous devrez utiliser le
programme OUTLINE.PRG ou OUTLINE.ACC fourni avec SpeedoGdos┐. Il existe
aussi d'autres utilitaires qui sont capables de lister toutes les polices
dont vous disposez.

/font_def(nom de remplacement,nom de la police)

Exemple : /font_def(gras,Swiss 721 Bold)

Dans le fichier d'aide, il suffira donc d'appliquer l'instruction /gras
dans cet exemple et le texte suivant sera affiché avec la police
correspondante.

Important :

Il est nullement nécessaire de définir une même police plusieurs fois dans
l'aide. En règle générale, ces définitions doivent se trouver en début du
fichier *.HLP pour plus de clarté. Pour les développeurs confirmés des
fichiers Diderot, il deviendra préférable d'utiliser l'instruction
/include.

9.1.2 Définir une fonte non-proportionnelle
-------------------------------------------

Comme décrit dans le chapitre 9.1, l'on peut avoir recours à des polices
vectorielles non-proportionnelles. L'on doit alors disposer dans son jeu de
fontes, de polices comme 'Courier 10 Pitch'. Cette fonction initialement
prévue pour les développeurs qui souhaitent faire paraître dans leur aide
un extrait de leur listing de programmation (source) permet en fait
d'afficher un texte comme la fonte système le ferait. Chaque caractère aura
donc une largeur identique, ce qui assure un alignement parfait.

source_font(nom de la police SpeedoGdos┐)

Exemple : source_font(Courier 10 Pitch)

A noter que les définitions de fontes comme /font_def et /source_font
n'agissent pas directement sur le texte. Ces instructions précisent
seulement que l'on va les utiliser dans une aide. Suivant les différentes
fontes définies, d'autres instructions seront chargées de les appliquer.

9.1.3 Utiliser une fonte non-proportionnelle
--------------------------------------------

Après avoir défini une fonte non-proportionnelle avec /source_font, vous
pouvez maintenant l'appliquer dans votre texte.

/begin_src

Le texte placé après cette instruction utilisera la police
non-proportionnelle définie par /source_font. A noter qu'il n'y a pas
d'autres paramètres à ajouter.

/end_src

Lorsque vous voulez en terminer avec cette même police, placez cette
instruction à la fin de votre texte. Là aussi, aucun paramètre
supplémentaire n'est nécessaire.

Exemple :

/begin_src
If "toto" = "titi" then 620
    620 Print "zorro"
End
/end_src

Il existe aussi une instruction spécifique aux polices non-proportionnelles
qui permet de définir les tabulations.

9.1.4 Utiliser une fonte proportionnelle
----------------------------------------

Après avoir défini les polices de caractères souhaitées avec /font_def,
l'on peut donc appliquer celles-ci dans le texte. Avec l'instruction
suivante, l'on spécifie directement le nom original de la fonte.

/font(nom de la police SpeedoGdos┐)

Exemple :

/font(Swiss 721 Bold)

D'autres possibilités plus évoluées et plus rapides sont décrites dans le
chapitre relatif aux 'Macros'.

Note : Si toutefois, vous ne spécifiez aucune police de caractères, ce sera
la fonte système qui sera utilisée par défaut. Cette même fonte est aussi
utilisée si SpeedoGdos┐ ou NDVI n'est pas installé.

9.1.5 Changer la taille d'une fonte
-----------------------------------

Comme l'on peut changer aisément de style de fonte, l'on peut tout autant
en modifier sa taille. En règle générale, l'on utilisera des tailles
définies en point d'imprimerie de l'ordre de 10, 12 ou 14. Les tailles plus
importantes seront réservées pour des titres ou pour la majuscule du début
d'un paragraphe. Pour certaines polices de caractères, une taille
inférieure à 10 ou 8 peut paraître difficile à lire. Vous êtes seul juge du
rendu final de l'aide, mais pensez aux éventuels lecteurs qui n'ont pas
forcement le même écran que vous ou une vue moins performante !

Note :

Vous devez obligatoirement préciser une taille au début de votre aide car
il n'existe pas de taille par défaut.

/font_size(taille en points)

Exemple : /font_size(10)

Comme pour l'instruction /font, elle devra être placée juste avant le texte
à modifier. Si la taille usuelle de votre texte est de 12 points, vous
pouvez définir n'importe quel caractère, mot ou phrase avec une taille
différente. Lorsque vous désirez reprendre la taille initiale, vous devez
remettre à nouveau cette instruction avec 12 points.

9.1.6 Changer la couleur d'une fonte
------------------------------------

Toutes les polices de caractères peuvent avoir une couleur de votre choix,
que ce soit la fonte système ou une fonte vectorielle. Là encore, on
évitera les effets un peu trop spéciaux comme des couleurs claires sur un
fond blanc.

/font_color(numéro d'index de la couleur)

Le numéro d'index est celui de l'ordre des couleurs de la palette que vous
utilisez. En mode monochrome, vous n'avez bien sûr droit qu'à 2 couleurs,
le blanc et le noir. Pour les TT et Falcon, vous avez droit à 16 couleurs,
256 et beaucoup plus.

La façon la plus pratique de visualiser vos couleurs est d'utiliser votre
panneau de contrôle. Vous retrouverez l'ordre des couleurs de gauche à
droite, la première étant le blanc(0), le noir(1), le rouge(2), ...

Conseils :

On prendra la précaution d'utiliser la palette de base que propose le GEM
afin que tous les utilisateurs de votre aide puissent avoir le même rendu.
Il est évident que si vous avez personnalisé votre palette et qu'un bleu
foncé corresponde à un rose, un autre utilisateur aura par défaut un bleu
foncé !

Evitez d'utiliser un texte en blanc sur fond noir. Il est reconnu que la
lisibilité est moindre et surtout plus fatigante. D'autre part, en mode
couleur, on en restera si possible au mode 16 couleurs qui est généralement
suffisant. Rappelez-vous toutefois qu'en mode monochrome ou 4 couleurs, les
couleurs dont l'index sur supérieur à 4 seront affichées en noir !

Exemple : /font_color(2) la couleur du texte suivant sera rouge.

Il n'est pas nécessaire de préciser la couleur au début de votre aide
puisque que le texte sera en noir par défaut.

9.1.7 Créer un fond de page
---------------------------

Comme il existe une instruction permettant de modifier la couleur des
caractères, il existe aussi une instruction réservée à la couleur du fond
de page. Par contre, cette instruction a d'autres avantages puisque l'on va
pouvoir définir en plus le motif (trame) ainsi que la présence ou non d'un
cadre (contour).

/b_ground(contour,couleur,motif)

Cette instruction appelée 'Background' (fond) est composée des paramètres
'contour' (encadrement), 'couleur' (couleur du fond) et 'motif' (trame).
Ses paramètres ont les valeurs suivantes :

Contour : 0 (pas de cadre) ou supérieur à 0

Les valeurs supérieures à 0 définissent l'épaisseur du cadre.

Couleur : numéro de la couleur comme dans le chapitre 9.1.6.

Motif : numéro du motif parmi l'un des 24 du GEM.

6 de ces motifs peuvent être visibles dans le panneau de contrôle (à partir
du STE) dans le CPX de configuration des couleurs de fenêtres. L'ensemble
des 24 motifs peuvent être découverts dans certains logiciels de dessin
comme Degas Elite par exemple.

Exemple : /b_ground(1,2,4)

Ici, l'épaisseur du cadre est un trait fin, la couleur est rouge et le
tramage (motif) est celui utilisé pour le fond du bureau GEM.

Comme pour la configuration des index dans Diderot, le motif n'est visible
que si la couleur n'est pas en blanc.

Conseil :

Si vous utilisez un fond sur une page ou plusieurs pages et que les autres
soient simplement en fond blanc (par défaut), il est conseillé de mettre
l'instruction /b_ground(0,0,0) après une instruction /ref. Ceci est dû au
fait que le visualiseur affiche les instructions dans l'ordre défini dans
le fichier *.HLP. Donc si vous placez une instruction /b_ground après avoir
affiché un texte, ce texte sera recouvert par le fond.

9.2 Macros
----------

Une macro est en fait une petite application qui regroupe plusieurs
instructions. Autrement dit, lorsque l'on souhaite utiliser plusieurs
instructions répétitives associées dans une aide, on regroupe toutes
celles-ci dans une seule. Le nom de cette macro est librement choisi par
l'utilisateur.

Si par défaut, le texte de l'aide est d'une taille de 10 points avec la
police de caractères 'Swiss 721 Italic' et d'une couleur rouge, il peut
paraître pénible d'avoir à écrire ces 3 instructions plusieurs fois dans le
texte. L'on va donc regrouper celles-ci en une seule que l'on appellera par
exemple /normal.

/user_def(nom de la macro;/instruction 1;/instruction 2;...)

Nom de la macro : c'est le nom choisi par l'utilisateur, ici celui-ci peut
être 'normal', 'défaut', 'titre', ...

Instruction : celle-ci peut être n'importe quelle instruction du langage
reconnu par Diderot, par exemple l'alias de la fonte utilisée définie par
/font_def, le taille définie par /font_size, la couleur définie par
/font_color. Il y a donc de multiples possibilités.

Exemple : /user_def(titre;/italic;/font_size(10);/font_color(2))

Ici, notre macro s'appelle 'titre', l'alias de fonte défini par /font_def
est 'italic', sa taille est de 10 points et sa couleur est rouge(2).

Dans le texte, on mettra donc seulement l'instruction /titre. En
conséquence, toutes les instructions associées seront appliquées à cet
instant.

Note :

Respectez bien la syntaxe de cette instruction où le nom de la macro est
défini sans le '/' et où chaque instruction associée est séparée par un
';'.

9.3 Tabulations
---------------

La tabulation permet de décaler un texte vers la droite avec un nombre
d'espaces fixes. La touche utilisée est [Tab]. Elle est généralement
utilisée pour décaler un paragraphe ou aligner plusieurs parties d'un
texte. Il faut savoir qu'une ligne précédée de plusieurs espaces dans votre
éditeur de texte ne sera représentée dans l'aide finale qu'avec un seul
espace. C'est pourquoi vous devrez passer par la tabulation lorsque votre
texte devra être décalé de plusieurs espaces.

Il existe 2 systèmes de tabulations. Le premier est constitué d'une seule
instruction simple liée uniquement à l'instruction /begin_src. Le deuxième
est constitué de 4 instructions permettant plus de possibilités qui est
appelé plus communément 'réglettes de texte'.

Le nombre d'espaces désiré est défini directement par le langage Diderot et
donc indépendant de celui généré par votre éditeur de texte. En règle
générale, on fixe une tabulation à 5 ou 8. Si elle est par exemple fixée à
5, une tabulation déplace le texte suivant de 5 espaces, s'il y a 2
tabulations, de 10 espaces et ainsi de suite.

Si vous ne souhaitez pas utiliser les systèmes de tabulations, vous aurez
la possibilité de faire appel aux instructions de décalage de marges dans
le cas de tabulations simples.

9.3.1 Tabulation pour /begin_src
--------------------------------

Lorsque vous utilisez l'instruction /begin_src dont la police est définie
initialement par /source_font, chaque tabulation rencontrée dans votre
texte est prise en compte. Le nombre d'espaces est précisé avec
l'instruction suivante :

/set_tab(nombre d'espaces)

Cette instruction peut être placée en début de votre aide si vous utilisez
toujours le même nombre d'espaces. Si le nombre d'espaces est différent
dans certaines parties du texte, vous pourrez ajouter cette instruction
autant de fois que vous le désirez.

Exemple :
/set_tab(5)
/begin_src
Sans tabulation
    Une tabulation
        Deux tabulations

Note :

Bien que cette instruction soit spécifique à /begin_src, vous pourrez aussi
utiliser les réglettes de texte.

9.3.2 Réglettes de texte
------------------------

Cet autre système de tabulation qui est plus évolué, n'est dépendant
d'aucune instruction. Il a été inspiré des réglettes de texte du logiciel
de P.A.O. Calamus. Le principe d'une réglette de texte est simple.
Matériellement, l'on peut imaginer une règle sur laquelle on dépose des
petits taquets sur une même ligne et que l'on peut déplacer à volonté. Au
dessous de celle-ci, chaque texte comportant une tabulation est déplacé
sous la position du taquet correspondant.

Exemple :

Si une ligne de texte est précédée d'une tabulation générée par la touche
[Tab], le texte commencera sous le premier taquet de la réglette. S'il y a
2 tabulations, le texte sera déplacé sous le deuxième taquet et ainsi de
suite.

Pour commencer, il faut d'abord créer une réglette vierge et lui donner un
nom avec l'instruction suivante :

/add_rule(nom de la réglette)

Ce nom est choisi librement par l'utilisateur comme 'Réglette 1' ou '2x50'.
On placera celle-ci ou d'autres si possible au début de l'aide afin de
mieux y accéder pour la modifier ou dans un fichier contenant toutes vos
définitions générales insérées avec l'instruction /include.

Ensuite l'on va y positionner des taquets. Contrairement aux tabulations
traditionnelles, la valeur de cette position n'est plus en nombre d'espaces
mais en pixels ce qui apporte plus de précision.

/add_tab(nom de la réglette,position en pixels)

Le nom de la réglette est celui défini au préalable avec l'instruction
/add_rule. En considérant une largeur d'écran de 640 pixels, l'on peut
mettre par exemple un premier taquet à 50 pixels ce qui correspond à 6
espaces à partir du bord gauche de l'écran. Une table de correspondance est
disponible dans le lexique en fin de cette aide.

Enfin, l'on peut utiliser cette réglette avant un texte avec l'instruction :

/use_rule(nom de la réglette)

L'on pourra ajouter autant de taquets et de règles différentes que
nécessaires. Parfois, l'on souhaitera simplement enlever dans l'aide
certains taquets. Une instruction est réservée à cet effet :

/del_tab(nom de la réglette,position en pixels)

Ici, on choisi le nom de la réglette à modifier et la position du taquet
qui doit disparaître. Avec une réglette dont le nom est 'Réglette 1', qui
posséde 3 taquets positionnés respectivement à 50, 100 et 150, le deuxième
taquet peut être enlevé avec : /del_tab(Réglette 1,100).

Chaque fois qu'un taquet a été enlevé et qu'il doit être réutilisé, l'on
devra le réinstaller avec l'instruction /add_tab.

9.4 Format de page
------------------

Bien que les utilisateurs de fichier d'aide utilisent des matériels
différents comme les écrans ou les imprimantes, il faudra définir un format
de page. Si l'on désire privilégier le format imprimante, l'on aura le
choix entre des formats prédéfinis comme le A4 ou Letter. Si c'est le
format écran, ce sera par exemple VGA ou 640*400. Dans tous les cas, l'on
sera libre de choisir toute autre résolution définie en pixels.

Les formats prédéfinis :

A3        (1510*1068)
A4        (755*1068)
A5        (534*755)
Letter    (776*1003)
Legal    (776*1280)
VGA        (640*480)

Les formats libres :

Free ou (largeur * hauteur)

/page_size(format prédéfini) ou /page_size(largeur * hauteur)

Exemple : /page_size(A4) ou page_size(Free) ou page_size(640*400)

Note :

Bien respecter la différenciation entre majuscules et minuscules pour les
formats prédéfinis. Cette instruction est obligatoire et doit être placée
au début du fichier d'aide.

9.5 Mise en page
----------------

Une fois que l'on a choisi notre format de page, d'autres instructions vont
permettre de positionner le texte dans l'aide. Ceci concerne les marges, la
longueur du texte, son alignement et éventuellement la présentation sous
forme de colonnes. Toutes les valeurs de ces fonctions ne sont pas en
nombre d'espaces mais en pixels.

9.5.1 Marges
------------

Comme dans un traitement de texte traditionnel, l'on peut définir 4 types
de marges afin que le texte ne soit pas "collé" sur les bords de l'écran ou
de l'imprimante. Il s'agit des marges haute, basse, droite et gauche. Dans
le cas d'utilisation de textes en colonnes, une autre instruction pour la
marge de gauche sera utilisée.

/top_page(nombre de pixels) ou /top_margin(nombre de pixels)

Espacement entre le haut de la page et le début de texte comme par exemple
/top_margin(150).

/bottom_margin(nombre de pixels)

Espacement entre le bas de la page et la fin du texte comme par exemple
/bottom_margin(55)

/left_margin(nombre de pixels)

Espacement entre le bord gauche de la page et le début du texte comme par
exemple /left_margin(40)

/right_margin(nombre de pixels)

Espacement entre le bord droit de la page et la fin du texte comme par
exemple /right_margin(100)

Toutes ces marges peuvent être utilisées plusieurs fois dans un texte en
fonction de la présentation que l'on désire donner à chaque page. Comme
décrit dans le chapitre des tabulations, la marge de gauche peut être
utilisée comme une tabulation en début de ligne. Pour chaque décalage
désiré, il suffit de spécifier à chaque fois une valeur de marge
différente.

Note :

La spécification de marges n'est absolument pas obligatoire mais peut nuire
à la présentation. L'on définira donc au minimum une marge haute et gauche.

Lors de formatage de texte en mode dit multi-colonage, l'on pourra utiliser
une marge de gauche indépendante de celle de la page. Cette marge sera donc
appliquée directement dans le texte mais à l'intérieur du cadre de la
colonne.

/margin(nombre de pixels)

Comme pour l'instruction /left_margin, l'on donnera l'espacement désiré en
pixels.

9.5.2 Justification
-------------------

La justification est en fait la façon dont va être aligné le texte. Il y a
4 principes de justification. Le texte peut être aligné sur le bord gauche
de la page, sur la droite, à gauche et à droite ou simplement centré. On
appelle aussi cette justification 'Fer à gauche' ou 'Fer à droite'.

Dans le cas d'un alignement à gauche et à droite, l'on préférera
l'utilisation de polices de caractères non-proportionnelles où la
présentation en sera améliorée puisque l'espacement entre caractères
s'effectue en valeur de pixels et non en nombre d'espaces.

A noter que les instructions qui suivent ne nécessitent pas de paramètres.
Celles-ci s'appliquent au texte qui suit directement.

Justification à gauche

/left

Justification à droite

/right

Justification à droite et gauche

/justify

Texte centré

/center

Note :

Par défaut, il est conseillé de spécifier une justification en début de
l'aide.

9.5.3 Largeur de texte
----------------------

Comme l'on utilise les marges d'une page pour "canaliser" le texte, l'on
peut aussi utiliser une instruction qui permette de définir la largeur que
tient un texte sans pour autant modifier la marge de droite.

/justify_length(largeur en pixels)

L'on pourra utiliser une largeur comme par exemple : /justify_length(600).
Cette instruction peut être librement utilisée à n'importe quel moment dans
le texte. Elle sera surtout utile lorsque vous positionnerez un texte à
côté d'une image.

9.5.4 Multi-colonage
--------------------

La présentation d'un texte peut être similaire à celle d'un journal. Pour
cela, l'on peut créer des colonnes virtuelles (sans cadre apparent) qui
seront alignées horizontalement dans la page. Il existe 2 instructions : la
première définit le nombre de colonnes souhaité et la la deuxième
l'espacement entre chaque colonnes. Cet espacement aura une valeur en
pixels et non en nombre d'espaces.

/column(nombre de colonnes)

Exemple : /column(3) avec le texte qui suit,

Ceci est un exemple de texte d'aide formaté en colonnes dans Diderot. La
longueur est dépendante du format de la page et des marges haute et basse.

Ceci est un     dans            du format
exemple de      Diderot.        de la page
texte           La longueur     et des marges
formaté         est             haute et
en colonnes     dépendante      basse.

Si la longueur du texte est dépendante du format de la page et des marges,
il en est de même en ce qui concerne la largeur de chaque colonne. De plus,
l'espacement défini entre chaque colonnes modifie aussi ces paramètres.

La fonction qui permet de définir l'espacement entre chaque colonne est
appelée aussi 'gouttière'.

/column_spacing(espacement en nombre de pixels)

Exemple : column_spacing(20)

Ici, 20 pixels sépareront chacune des colonnes.

Note :

La valeur par défaut pour /column est de 1 et de 10 pixels pour
/column_spacing.

10.0 Instructions spéciales
===========================

Les instructions spéciales concernent la gestion d'images, de sons, de
musiques ou bien la définition d'une zone de page d'aide pouvant être
interactive. Ce chapitre est vraisemblablement amené a être complété par
bien d'autres instructions intéressantes.

10.1 Insertion d'images
-----------------------

Il existe 2 façons d'utiliser une image dans une aide. La première consiste
simplement à l'afficher pour agrémenter ou compléter l'explication d'un
texte. La deuxième est identique mais permet en plus à l'utilisateur de
cliquer dessus afin d'accéder à d'autres informations relatives à l'image.
A noter que cette image pourra être découpée en plusieurs zones de clic et
où chacune de ces zones permettra d'accéder à des pages différentes.

Vous devrez au préalable créer vos images ou les capturer sur un écran. Il
sera nécessaire de posséder quelques outils graphiques comme un logiciel de
dessin acceptant le format GEM-(X)IMG et éventuellement un 'snapshot' qui a
pour rôle de faire une capture intégrale ou partielle de votre écran. Là
encore, il devra accepter le format GEM-(X)IMG. Toutefois, si ce format
n'était pas reconnu par votre logiciel de dessin ou votre 'snapshot', il
existe une multitude d'utilitaires de conversion de formats d'images.

Note :

Bien que Diderot puisse être utilisé en résolution couleur, toutes les
images devront être en monochrome (2 couleurs).

Toutes ces images devront être sauvegardées si possible dans un dossier
créé spécialement pour votre aide. Cela permet déjà de mieux s'organiser et
surtout de se souvenir de ce répertoire puisque qu'il faudra l'utiliser
dans les instructions.

Il n'y a pas de limitations quand au nombre d'images dans une page ou dans
l'ensemble de l'aide. Cependant, l'excès d'images peut entraîner un fichier
d'aide d'une taille importante.

10.1.1 Images simples
---------------------

L'instruction suivante permet d'afficher une ou plusieurs images dans un
fichier d'aide :

/img(x,y,mode d'affichage,répertoire et nom de l'image)

x : coordonnée horizontale en pixels de la position de l'image
y : coordonnée verticale en pixels de la position de l'image
Mode d'affichage : (1)opaque ou (2)transparent
Répertoire et nom : lecteur, répertoire et nom du fichier de l'image

Exemple : /img(100,100,2,d:\diderot\images\diderot.img)

Ici, l'image est positionnée à 100 pixels à partir du bord gauche de la
fenêtre et à 100 pixels du bord haut. L'image DIDEROT.IMG est sur le
lecteur D: dans le sous-dossier 'IMAGES' du dossier DIDEROT. Son aspect est
transparent.

L'image est dite transparente lorsqu'un texte débordant sur cette celle-ci
est visible. Le texte est donc mélangé à l'image. Si l'image est opaque, le
texte débordant sur celle-ci sera caché. Le mode d'affichage s'applique
aussi lors d'utilisation d'un fond de page.

Conseil :

Certains logiciels de dessin indiquent les coordonnées en x et y suivant la
position de la souris. Utilisez celles-ci pour vous aider à relever les
coordonnées nécessaires à l'instruction. Bien entendu, vous prendrez soin
d'être à l'échelle 1:1.

10.1.2 Images interactives
--------------------------

Une instruction identique à /img permet non seulement d'afficher une image
mais de la rendre interactive. Ce qui veut dire que l'on va pouvoir cliquer
dessus pour accéder à une autre page de l'aide.

/idx_img(x,y,mode d'affichage,répertoire et nom de l'image,référence)

Les paramètres 'x', 'y', 'mode d'affichage' et 'nom de l'image' sont
identiques à l'instruction /img. Le paramètre 'référence' est
l'indentification de la page (nom) définie initialement par l'instruction
/ref.

Exemple : /idx_img(100,100,2,d:\diderot\images\diderot.img,21)

Lorsque que l'on cliquera sur l'image, l'on ira directement à la page
commençant par l'instruction /ref(21).

10.2 Modules sonores
--------------------

Comme l'on peut insérer des images dans une aide, l'on peut y ajouter des
sons. Une instruction va permettre de jouer des modules sonores. Les
modules sont généralement des morceaux de musique. Il existe de multiples
utilitaires permettant d'interpréter ces modules ou même de les créer. Les
modules devront avoir l'extension *.MOD.

Toutefois, il sera nécessaire d'avoir à disposition l'accessoire U-TRACK.

Contrairement aux images, les modules ne seront pas compilés dans le
fichier d'aide final. En conséquence, un autre utilisateur de votre aide
devra posséder les modules que vous aurez défini, sans quoi, il ne pourront
être interprétés.

L'activation de la reproduction des modules et le choix de leurs
répertoires doit être spécifié dans le panneau de configuration de Diderot.

/mod(nom du fichier)

Exemple : /mod(tunisia.mod)

Dès que cette instruction sera rencontrée pendant la consultation de
l'aide, le module 'Tunisia' sera interprété s'il existe dans le répertoire
spécifié dans le panneau de configuration de Diderot, si l'option 'Jouer
les modules' est active et si l'accessoire U_TRACK est présent.

10.3 Echantillons sonores
-------------------------

Les échantillons sonores sont en fait des sons généralement de courte
durée, bien que tout soit possible ! Ils sont aussi appelés 'samples'. A la
différence des modules, on les utilisera dans Diderot d'une façon
interactive. Ce qui veut dire que l'on réservera une zone dans une page
d'aide sur laquelle on pourra cliquer dessus. Comme pour l'instruction
/idx_img qui nous emmène sur une autre page lorsque l'on clique sur image,
ici, c'est un son qui sera généré. La encore, on ne compte plus les
utilitaires de traitement du son.

Les échantillons seront avec l'extension *.SPL, d'une fréquence de 12,5 Khz
et d'une résolution de 8 bits en mono. Il est conseillé comme pour les
images de mettre les échantillons dans un dossier spécifique au fichier
d'aide, le répertoire devant être facilement mémorisable puisque il est
utilisé dans l'instruction.

/sound_button(x,y,l,h,nom du fichier)

Ici, 'x' et 'y' déterminent les coordonnées en pixels du début de la zone
de clic comme pour l'instruction /img. 'l' est la largeur en pixels de la
zone de clic et 'h', la hauteur. Le nom du fichier devra être précédé du
lecteur et du répertoire où il se trouve.

Exemple : /sound_button(5,13,280,320,d:\sons\epee.spl)

Le début de la zone de clic se trouve à 5 pixels du bord gauche de la page
et à 13 du haut de la page. La zone de clic est de 280 pixels de large et
de 320 de haut. Il sera généré le son EPEE.SPL contenu sur le lecteur D:
dans le dossier 'SONS'.

Conseils :

Il est tout à fait possible de définir une zone de clic dans n'importe quel
endroit de la page, même sur du texte. Attention toutefois à ce que cette
zone ne couvre pas une partie du texte comportant des index. Aussi, l'on
pourra au préalable afficher une simple image avec l'instruction /img puis
associer une zone de clic sonore sur cette image, voire même plusieurs.

10.4 Zone de page interactive
-----------------------------

L'instruction qui suit est similaire à la précédente /sound_button. A la
seule différence, c'est que au lieu de générer un son lorsque l'on clique
sur une partie de l'écran, ici, l'on sera emmené dans une autre référence
définie par /ref.

/zone_button(x,y,l,h,référence de la page)

Les 4 premiers paramètres 'x', 'y', 'l' et 'h' sont strictement identiques
à l'instruction /sound_button. Le paramètre 'référence de la page' est
l'identification de la page relative à la zone cliquée.

Exemple : /zone_button(5,13,280,320,sommaire)

Le début de la zone de clic se trouve à 5 pixels du bord gauche de la page
et à 13 du haut de la page. La zone de clic est de 280 pixels de large et
de 320 de haut. Lorsque l'on cliquera dans cette zone, l'on sera amené à la
page dont la référence est /ref(sommaire).

10.5 Exécuter un programme sous Diderot
---------------------------------------

Diderot donne la possibilité de pouvoir exécuter un programme lors de la
consultation d'une aide. Ce programme pourra fonctionner en tâche de fond
en même temps que Diderot. Cependant, ce système ne fonctionne qu'en
multi-tâches, c'est-à-dire sous MultiTos.

/exec(répertoire et nom du programme,arguments)

Exemple : /exec(d:\everest\everest.prg,diderot.txt)

Lorsque cette instruction sera rencontrée dans l'aide, le programme
'EVEREST.PRG' sera exécuté et le fichier 'DIDEROT.TXT' sera chargé dans
celui-ci. Les arguments peuvent aussi des paramètres utilisés par certaines
applications. Pour comprendre un peu mieux ceux-ci, consultez le lexique
sur les applications ou l'utilisation du compilateur de Diderot.

10.6 Insérer des fichiers d'aide types
--------------------------------------

Lors de la création de fichiers d'aide, certains descriptifs types de
fonctionnalités sont souvent utilisés comme : comment formater une
disquette, utiliser un éditeur de texte, ... Il peut paraître donc
fastidieux d'avoir à recommencer de taper ces descriptions à chaque fois
que vous créerez une nouvelle aide.

Vous pourrez donc vous constituer une bibliothèque de fichiers *.HLP
décrivant certaines manipulations standards. Aussi, ces fichiers peuvent
être des configurations standard spécifiques à Diderot comme le format, les
marges, les polices de caractères utilisées, ...

L'on prendra soin, comme pour les images et les sons de classer proprement
ces petits fichiers dans un dossier réservé à cet effet.

L'instruction est simple à mettre en oeuvre et peut être installée à
n'importe quel endroit dans votre aide :

/include(répertoire et nom du fichier 'HLP')

Exemple : /include(d:\diderot\macros\format.hlp)

Lors de la compilation, le fichier 'FORMAT.HLP' sera recherché et donc
inséré à l'endroit où se trouve l'instruction dans votre aide.

11.0 Utiliser le compilateur
============================

Comme cela a déjà été expliqué au chapitre 7.1, le fichier d'aide *.HLP
n'est pas exploitable directement par l'accessoire ou le programme Diderot.
Le fichier *.HLP est un fichier ASCII qui ne contient que du texte. Il peut
être aussi appelé 'fichier source' comme en programmation.

Pour utiliser ce fichier source, il devra être compilé à l'aide du
programme DIDCOMxx.GTP qui est en fait le compilateur. Ce programme ne
possédant pas d'interface GEM devra comporter certains paramètres lors de
son exécution. Si vous n'êtes pas familiarisé avec ce genre d'application,
référez-vous au lexique en fin de cette documentation.

Une fois la compilation terminée, un fichier *.AID apparaîtra à côté du
fichier source. A cet instant, ce nouveau fichier pourra être directement
exploité par Diderot.

Lorsque vous double-cliquez sur DIDCOMxx.GTP, une boîte s'ouvre vous
demandant des paramètres. Par défaut, aucun paramètre particulier n'est
nécessaire. Vous devrez toutefois entrer le nom du fichier *.HLP à compiler
ainsi que son répertoire :

d:\aides\aide.hlp

Si le fichier d'aide se trouve dans le même répertoire que le compilateur,
il n'est pas nécessaire de faire paraître le répertoire :

aide.hlp

Conseil : avant de démarrer toute compilation, assurez-vous que SpeedoGdos┐
soit installé si vous utilisez des polices de caractères vectorielles et
que toutes celles utilisées dans votre aide soient bien définies dans le
fichier EXTEND.SYS. Assurez-vous aussi que tous les répertoires pour les
images, les sons, les fichiers d'aide types n'ont pas été modifiés.

11.1 Paramètres de compilation
------------------------------

Il existe 5 paramètres disponibles qui sont simplement des lettres
précédées d'un tiret que vous aurez a placer devant le nom du fichier
source *.HLP à compiler.

-v : C'est l'option qui permet d'afficher le résultat de l'aide lors de la
compilation. Elle est fortement conseillée par défaut pour toute
compilation. Paradoxalement, si elle n'est pas utilisée, le temps de
compilation sera très long. Ce problème est vraisemblement dû à SpeedoGdos┐
lui-même.

-s : Utilisée conjointement avec l'option précédente, celle-ci informe le
compilateur de s'arrêter après chaque page affichée. Pour continuer, vous
devrez taper une touche.

-c : Destinée aux développeurs qui souhaitent intégrer le système d'aide
Diderot dans leur programme, cette option génère un fichier portant le nom
de l'aide originale avec l'extension *.H pour le langage C.

-b : Cette option est identique à la précédente mais pour le langage Basic.
L'extension sera *.LST.

-e : Option utile lors des premiers essais de compilation, elle génère un
fichier ASCII comportant la liste des éventuelles erreurs rencontrées lors
du processus. Son extension sera *.LOG. On appelle aussi ces fichiers *.LOG
des fichiers 'journal', c'est-à-dire qui retracent une liste d'évenements.

Exemples de syntaxes :

-ve d:\aides\aide.hlp

Ici, l'aide finale sera affichée à l'écran et un fichier AIDE.LOG sera
généré. Le fichier AIDE.HLP sera dans le dossier AIDES du lecteur D:.

-vc aide.hlp

Ici, l'aide est toujours affichée à l'écran et un fichier AIDE.H sera
généré. Le fichier AIDE.HLP sera dans le même répertoire que celui du
compilateur.

Comme vous aurez pu le constater, le tiret n'apparaît qu'une fois en début
de ligne. D'autre part, l'espace entre les paramètres et le nom du fichier
est obligatoire, sans quoi, le fichier en question ne pourra être trouvé.

11.2 Erreurs dans la compilation
--------------------------------

Lorsque par exemple un index ne comporte pas de référence associée ou
qu'une instruction comporte une erreur de syntaxe, les messages d'erreurs
correspondants sont affichés à l'écran durant la compilation. Si le
paramètre -e est défini, ces mêmes messages seront transcrits dans le
fichier *.LOG.

Après relevé de ces erreurs, vous devrez obligatoirement les corriger.
Autrement, l'utilisation du fichier *.AID peut s'avérer catastrophique,
voire impossible.

11.3 La table des symboles
--------------------------

Depuis la version 1.14 de Diderot, lors de la compilation, un fichier *.SYM
est généré. Ce fichier, appelé aussi "table des symboles" contient toutes
les références utilisées dans l'aide. Cette liste est accessible dans
Diderot par l'icône '?'. A noter que ce fichier n'est pas nécessaire pour
visualiser un aide.

12.0 Lexique
============

Le lexique est essentiellement réservé à ceux qui sont novices sur Atari╛.
Vous y trouverez quelques explications simples pour des applications
standard.

12.1 Renommer un fichier
------------------------

Pour renommer un fichier à partir du bureau GEM, ouvrez la fenêtre et
éventuellement le(s) dossier(s) choisi(s) puis cliquez une fois sur le
fichier concerné (sous forme d'icône ou de texte). Une fois le fichier
sélectionné (en vidéo inverse), allez dans le menu 'Fichier' et cliquez sur
'Informations'.

Une boîte s'ouvre et vous présente le nom du fichier choisi ainsi que
d'autres paramètres relatifs à celui-ci. Le curseur étant positionné
automatiquement sur le nom du fichier, tapez plusieurs fois [Backspace]
pour effacer caractère par caractère ou [Esc] pour effacer la totalité.
Vous pouvez aussi utiliser les flèches [<] et [>] pour vous déplacer dans
le nom. [Backspace] efface le caractère précédent le curseur et [Delete] le
caractère suivant le curseur.

Tapez ensuite le nouveau nom de fichier (8 caractères) suivi de son
extension (3 caractères). Si le nom du fichier fait moins de 8 caractères,
vous pouvez passer directement à la saisie de l'extension en appuyant sur
la touche [.] (point).

Les seuls caractères autorisés sont les lettres, les chiffres et le tiret
de soulignage [_]. Les espaces ne sont pas reconnus.

12.2 Fichier ASCII
------------------

Un fichier ASCII ne contient que du texte. De ce fait, vous n'y trouverez
aucun graphisme ou toute autre chose. Ce fichier peut être par exemple une
simple lettre ou un langage de programmation, mais la liste n'est pas
limitative. L'ASCII est un format standard et a pour avantage d'être
reconnu par toutes les machines existantes à ce jour.

Dans la table ASCII, tous les caractères sont numérotés. Bien que les
lettres et les chiffres soient universels, certains caractères sont propres
à chaque machine. Ainsi, un 'é' n'aura pas forcément le même numéro sur une
autre machine et correspondra peut-être à un autre caractère.

Un fichier ASCII peut être créé généralement à partir d'un logiciel appelé
éditeur de texte ou traitement de texte. Il existe de multiples formes
d'applications pour saisir du texte.

Le fichier ASCII peut simplement servir à créer un texte qui pourra être lu
et imprimé. Mais il peut être un support pour un logiciel particulier. Ce
logiciel pourra par exemple venir y chercher des informations ou des
instructions pour des applications bien spécifiques.

Les extensions traditionnelles employées pour les fichiers ASCII sont
généralement *.TXT ou *.ASC. Toutefois, il n'y aucun impératif quand au
choix de cette extension.

12.3 Editeur de texte
---------------------

Comme décrit dans le chapitre précédent, l'éditeur de texte est un logiciel
qui permet de saisir uniquement du texte. Contrairement aux traitements de
texte, il n'y aucune fonctionnalité permettant de souligner un texte,
insérer des graphismes, ...

L'éditeur de texte pur ne gère qu'un seul format qui est l'ASCII.
Cependant, la majorité des traitements de texte savent exporter et importer
les fichiers ASCII.

Il existe une multitude de logiciels dits éditeurs de texte. Chaque
logiciel, placé dans le domaine public ou non, apportent chacun des
fonctionnalités standard et d'autres qui permettent un confort plus au
moins avancé dans l'utilisation. De plus, certains sont orientés pour
certaines applications spécifiques comme la programmation, le Vidéotex, ...

En résumé, vous trouverez très facilement cet outil de travail
indispensable qu'est l'éditeur de texte.

12.4 Pixel
----------

Le pixel est en fait une unité de résolution graphique. Sur un écran, le
pixel est le plus petit point d'affichage. L'on défini donc la résolution
en pixels soit par exemple 640 x 400 pour les écrans monochrome Atari╛ ou
640 x 480 pour les écrans de type VGA. Ce qui veut dire qu'il y a 640
points alignés en largeur et 400 en hauteur soit 256000 points dans la
totalité de l'écran.

Plus il y a de points sur un écran, plus le pixel est petit et meilleure
est la résolution. Certains logiciels de dessin ou autres utilitaires
peuvent afficher les coordonnées en 'x' et 'y' de la souris. Le 'x' est
l'horizontale et le 'y' la verticale. Ces coordonnées sont exprimées en
pixels. Si l'on positionne la souris sur le bord gauche de l'écran, la
valeur de 'x' doit être '0'. Lorsque que la souris est déplacée sur le bord
opposé, la valeur sera par exemple de 640 pixels avec un écran monochrome
Atari╛.

12.5 Installer une application
------------------------------

Sur les systèmes Atari╛, une application est en fait un 'bout de programme'
interne au GEM qui va permettre l'automatisation et le transferts de
paramètres à l'exécution d'un programme.

Un exemple simple d'application est celui des touches de fonction qui
lancent un programme lorsque l'on appui sur l'une de celles-ci. Cette
fonctionnalité s'applique uniquement sur des versions de TOS récentes.
Aussi, et tel est l'intérêt premier d'une application, il sera possible
d'exécuter automatiquement un programme lorsque l'on cliquera sur l'un des
fichiers qui lui sont associés. De plus, le fichier choisi sera chargé à
l'intérieur du programme. Il en est de même, lorsque l'on déplacera une
icône sur ce programme.

Sur le bureau GEM se trouve un menu appelé 'Options' et dans lequel
apparaît l'objet 'Installer une application'. Cet objet est par défaut
grisé et donc, non sélectionnable. Pour qu'il soit accessible, il faudra au
préalable ouvrir une fenêtre et choisir en cliquant une seule fois dessus
un programme exécutable tel que PRG, APP, GTP ou TTP. Lorsque ce programme
est sélectionné, l'objet 'Installer une application' du menu 'Options' sera
accessible.

12.5.1 Description de la boîte de configuration
-----------------------------------------------

Une fois la boîte ouverte, s'affiche en haut le nom du programme qui a été
choisi. Au dessous, l'on trouve un champ appelé 'Paramètres' puis 'Type de
document'. Sur les versions des TOS récents, l'on trouve 2 menus popup. Le
premier définit si le programme choisi sera lancé automatiquement ou
manuellement au démarrage de la machine et l'autre si celui-ci doit être
exécuté à partir d'une touche de fonction. Pour toutes les machines
apparaît une autre menu popup qui propose à l'utilisateur le choix entre 4
types de fichier : GEM, GEM avec paramètres, TOS et TOS avec paramètres.
Enfin, les 2 derniers menus popup dont le premier concerne le répertoire
utilisé pour l'application 'Fenêtre' ou 'Application' et le deuxième qui
concerne le paramètre à transmettre 'Nom du fichier' ou 'Répertoire'.

Après description de ces paramètres, des exemples vous permettront de mieux
comprendre leur rôle.

12.5.2 Paramètres
-----------------

Les paramètres sont généralement des lettres ou mots précédés d'un tiret.
Ceux-ci sont propres au programme choisi et ne font pas partie du GEM. Ces
paramètres, qui sont transmis au programme lors de son exécution servent à
accomplir des tâches bien spécifiques. Généralement utilisés avec des
programmes TOS sans interface GEM comme les *.TTP ou *.GTP, il faudra donc
spécifier un ou plusieurs de ces paramètres afin que le programme puisse
travailler correctement.

Exemple :

Lorsque l'on désire décompacter une archive au format LZH avec le programme
LHARC.TTP, il est nécessaire de faire paraître l'option '-x'. Cette option
informe simplement LHARC.TTP qu'il doit décompacter une archive.

12.5.3 Type de document
-----------------------

Le type de document est en fait l'extension des fichiers utilisés par le
programme. Si votre programme est par exemple un traitement de texte et où
les fichiers traités par celui-ci portent l'extension *.DOC, ce sera cette
extension qui sera inscrite dans le champ.

12.5.4 Démarrage
----------------

Le démarrage d'un programme peut être manuel ou automatique. Lorsqu'il est
manuel, l'on doit simplement double-cliquer dessus pour que le programme se
lance. Lorsqu'il est automatique, le programme est exécuté immédiatement
après le démarrage de la machine. Cependant, l'information de démarrage
automatique d'un programme doit être enregistrée dans le fichier
NEWDESK.INF. Cette opération s'effectue avec l'objet du menu 'Options' :
'Sauver le bureau'. Cette fonctionnalité n'existe pas dans les TOS dont la
version est inférieure à 1.4. Ces versions sont reconnaissables grâce au
fichier du bureau généré par le GEM DESKTOP.INF et non NEWDESK.INF.

12.5.5 Appelée par
------------------

Sur les versions des TOS récents, les touches de fonctions [F1] à [F10]
peuvent associées au démarrage des programmes. En fait, il y a même 20
touches de disponibles puisque l'une des touches [Shift] peut être
combinée. Les touches [F1] à [F10] sont accessibles directement et les
touches [F11] à [F20] en combinaison avec l'une des touches [Shift]. La
touche [F11] correspond en fait à [Shift]+[F1].

Lorsqu'une touche aura été définie pour un programme, à chaque fois que
vous appuierez sur celle-ci à partir du bureau, le programme associé sera
exécuté. A noter que si votre programme utilise lui-aussi les touches de
fonction, celles-ci prendront leur fonctionnalité propre.

Comme pour le démarrage, cette option n'existe que pour les versions du TOS
récentes.

12.5.6 Type de fichier
----------------------

Il existe 4 types de programmes. Les programmes dits GEM reconnaissables à
leur interface avec fenêtres, boîtes d'alerte, ... ceux en fait les plus
usités. Les programmes GEM avec paramètres qui sont similaires aux
précédents mais dont il faut préciser des paramètres spécifiques afin
qu'ils puissent fonctionner correctement. Enfin, les programmes TOS qui
n'utilisent pas l'interface du GEM avec ou sans paramètres.

Vous pourrez vous rendre compte facilement si votre programme a besoin de
paramètres particuliers ou non pour fonctionner et d'autre part si celui-ci
utilise ou non l'interface GEM.

12.5.7 Répertoire
-----------------

Ici, l'on devra définir quel est le répertoire utilisé pour notre
programme. Cette option étant sur 'Fenêtre', le répertoire est celui de la
fenêtre où se trouve le fichier associé. Si le 'Type de document' est 'DOC'
et que l'on double-clique sur un fichier *.DOC, le programme va utiliser ce
chemin pour charger automatiquement le fichier. Si l'option est sur
'Application', le chemin sera celui où se trouve le programme.

12.5.8 Paramètre
----------------

En plus des éventuels paramètres transmis au programme lors de son
exécution, il est nécessaire de définir le nom du fichier associé à ce
programme. Cependant, il se peut que seul le nom du fichier soit nécessaire
ou alors l'intégralité du répertoire et le nom. Nous avons par exemple un
répertoire et un fichier donné : d:\utilit\essai.txt.

Avec 'Nom du fichier', seul 'essai.txt' est transmis.

Avec 'Répertoire', l'on aura 'd:\utilit\essai.txt'.

12.5.9 Exemples précis d'applications
-------------------------------------

Associer une touche de fonction à un programme :

- Ouvrez la fenêtre et éventuellement le ou les dossiers où se trouve le
programme sélectionnez celui-ci en cliquant une fois dessus.
- Allez dans 'Installer une application' et choisissez la touche de
fonction désirée.
- Cliquez sur [Installer] puis sauvegardez le bureau avec 'Sauver le
bureau'.
- Vous pouvez à présent lancer votre programme en appuyant sur la touche de
fonction définie.

Associer un type de document à un programme :

- Faites comme précédemment en sélectionnant le programme désiré.
- Si par exemple votre programme de traitement de texte gère les fichiers
portant l'extension *.DOC, tapez 'DOC' dans le champ 'Type de document'.
- Choisissez le type de fichier 'GEM ou TOS avec ou sans paramètres.
- Sélectionnez pour 'Répertoire' : 'Fenêtre'.
- Sélectionnez pour 'Paramètre' : 'Nom de fichier'.
- Cliquez sur [Installer] et sauvegardez le bureau.
- Dès lors, chaque fois que vous cliquerez 2 fois sur une icône *.DOC,
votre traitement de texte sera exécuté et le fichier *.DOC sera
automatiquement chargé à l'intérieur de celui-ci.
- Il en est de même lorsqu'une icône *.DOC sera tirée celle du programme de
votre traitement de texte.

Cette exemple est une procédure générale. Toutefois, il se peut que votre
programme ne reconnaisse pas ce protocole ou que le menu popup 'Paramètre'
soit défini par 'Répertoire' et non 'Nom de fichier'. Dans tous les cas,
reportez-vous à la documentation de votre logiciel.

Définir des paramètres pour une application :

- Sélectionnez votre programme et allez dans 'Installer une application'.
- Si vous utilisez par exemple LHARC.TTP, installez le paramètre -x suivi
d'un espace dans le champ 'Paramètres'.
- Mettez 'LZH' dans 'Type de document'.
- Choisissez le type de fichier 'TOS avec paramètres'.
- Sélectionnez pour 'Répertoire' : 'Fenêtre'.
- Sélectionnez pour 'Paramètre' : 'Nom de fichier'.
- Cliquez sur [Installer] et sauvegardez le bureau.
- A cet instant, chaque fois que vous double-cliquerez sur une archive
*.LZH, l'ensemble des fichiers de celle-ci sera automatiquement décompacté.

L'ensemble des exemples ci-dessus ne sont donnés qu'à titre indicatif.
Toute procédure d'application est particulière à chaque logiciel. Il est
donc indispensable de consulter le documentation du logiciel surtout
lorsqu'il y a des paramètres spécifiques. Effectuez des essais et
assurez-vous d'avoir une copie de tous les fichiers que vous utiliserez.

13.0 Table de correspondance 'caractères/pixels'
------------------------------------------------

Cette table a pour objet de convertir la position des caractères de la
fonte système en pixels dans une fenêtre GEM ouverte dans sa totalité. Elle
vous aidera à positionner vos images et vos zones de clic. Les mesures ont
été effectuées à partir du bord gauche et du bord supérieur (sous la barre
de titre) de la fenêtre.

A partir du bord supérieur et à partir du bord gauche :

ligne 03        044 pixels      colonne 06      050 pixels
ligne 04        061 pixels      colonne 12      100 pixels
ligne 05        076 pixels      colonne 18      150 pixels
ligne 06        092 pixels      colonne 25      200 pixels
ligne 07        108 pixels      colonne 31      250 pixels
ligne 08        124 pixels      colonne 37      300 pixels
ligne 09        141 pixels      colonne 43      350 pixels
ligne 10        157 pixels      colonne 50      400 pixels
ligne 11        172 pixels      colonne 56      450 pixels
ligne 12        188 pixels      colonne 62      500 pixels
ligne 13        204 pixels      colonne 68      550 pixels
ligne 14        219 pixels      colonne 75      600 pixels
ligne 15        237 pixels
ligne 16        253 pixels
ligne 17        269 pixels
ligne 18        285 pixels
ligne 19        299 pixels

14.0 Shareware
==============

Il existe différents statuts d'utilisation des logiciels. Le logiciel dit
commercial, acheté chez un revendeur et donc nominatif (sauf conventions
particulières multi-utilisateurs). Le logiciel dit "Freeware", totalement
gratuit et libre d'utilisation et de diffusion. Il existe aussi un dérivé
appelé "Postcardware" libre aussi d'utilisation mais où l'on doit prévenir
l'auteur par l'envoi d'une simple carte postale. Enfin, vient le
"Shareware" qui est le statut de Diderot.

Les logiciels diffusés en "Shareware" ne sont ni gratuits, ni commerciaux.
Cela veut dire que vous pouvez tester et évaluer librement ceux-ci. A
partir du moment où un logiciel vous intéresse et que vous souhaitez
l'utiliser régulièrement, vous devez apporter une contribution généralement
peu onéreuse à l'auteur. A cet instant, vous êtes considéré comme
utilisateur enregistré et donc pouvez utiliser le logiciel autant que vous
le voulez.

A noter que souvent, certaines versions dites de démonstration sont bridées
et certaines fonctionnalités ne sont pas accessibles. C'est le cas de
Diderot où l'impression n'est pas disponible et où un message d'information
apparaît à chaque fois que vous lancez le programme. Bien entendu, ces
contraintes disparaissent dès lors que vous êtes enregistré auprès de
l'auteur.

La copie et la diffusion de logiciels de démonstration est libre et
fortement conseillée (sauf avis contraire le l'auteur). A l'inverse, les
versions enregistrées et nominatives ne doivent absolument pas être cédées.
Seules sont autorisées les copies à titre privé et dites de sécurité. Toute
copie ou diffusion illégale est passible de peines citées par la loi.

En conséquence, si Diderot vous intéresse, contactez l'auteur et
envoyez-lui la somme de 50,00 FF, 20 DM ou 15 $US pour le programme seul ou
100 FF, 40 DM ou 30 $US pour l'ensemble (programme et compilateur).

Mises à jour :

Pour recevoir la dernière version de Diderot, envoyez simplement à l'auteur
une disquette et une enveloppe-retour affranchie à 3,50F (tarif économique)
ou 4,40F (tarif normal). Ce tarif est celui en vigueur au 1/12/1995.

15.0 Contacter l'auteur
=======================

David RENE-LOISEAU
72, rue du pont de César
NERONVILLE
77570 CHATEAU-LANDON
FRANCE

16.0 Remerciements
==================

Claire-Emmanuelle RENE-LOISEAU
Claude ATTARD
Thierry RODOLFO
Pascal DAULIAC
J. GUERIN
BRAINSTORM
Christophe POMMEREAU
Jean-Michel COINUS

et tous ceux qui ne sont pas nommés !